home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Tampa Bay Amiga Group / TBAG - Tampa Bay Amiga Group's Disk of the Month #71 (1992)(Merlin's Software - Amiganuts United)(PD).zip / TBAG - Tampa Bay Amiga Group's Disk of the Month #71 (1992)(Merlin's Software - Amiganuts United)(PD).adf / Docs / Mod2Exe.DOCS < prev    next >
Text File  |  1992-07-14  |  10KB  |  202 lines
  1.  
  2.  
  3.    ------------------- PHILOSOPHY SOFTWORKS PRESENTS -------------------
  4.        ,__,    ,__,           _g                _______
  5.        "7##    d#F"           "#L     jN#p_     "##""N#
  6.         jN#p   N#F             #L     #p ##      ##   0
  7.         jFN&  jN#F    __     __#L     0F 0#      ## q t __   __  ___
  8.         jLtN  & #F  j0"Nh  j0"N#L        #@      ##_#   `N#'5P' j#"0p
  9.         jLJ#LjL #F  0F  #p #F  #L       j@       ##"#     0L0   NF j#
  10.         jL 0#J  #F  #F  #F #F  #L      _@ ,      ## * jL   #L   #p**N
  11.         jL ]#F  #F  NF  #F #F  #L      @__0      ##   j   jN#   #L  _
  12.        _jL_ #  _#F_ 9#_j#  9& j#L     d####     _##__jN  _@ 0#_ 9#__0
  13.        XXXX :  XXXX  "XX"   "XX"X               XXXXXXX  XX  XX  "XX"
  14.  
  15.    ------------------------------ MOD2EXE ------------------------------
  16.  
  17.                             .-----------------.
  18.                             |** What is it? **|
  19.                             `-----------------'
  20.  
  21. Mod2Exe is a program to convert a SoundTracker/NoiseTracker module into an
  22. executable file.  The program provides a way for anyone to easily
  23. transform mods into executable that will multitask smoothly with your
  24. other programs.  Additionally, it will automatically create an icon if you
  25. wish so that it can be run from the workbench by even the most novice of
  26. users.  It is also useful in that it doesn't provide a way to stop it
  27. except for the KillPlayer program or running the mod (or any other
  28. executable mod) again.  This way, if you're using it for a demo (for
  29. instance) then it wouldn't be accidentally stopped by a nosey user.
  30.  
  31.                    .----------------------------------.
  32.                    |** Compatibility & Requirements **|
  33.                    `----------------------------------'
  34.  
  35. Mod2Exe requires an Amiga personal computer and Workbench version 1.3.
  36. As with ANY program, the more memory you have, the more use you will get
  37. out of the program.  However, 512k should be sufficient for average mods.
  38. Note that the executable mod loads itself into CHIP RAM, so 1 meg CHIP
  39. would be a big plus!
  40.  
  41. Mod2Exe makes no claims as to its functionality on systems running other
  42. than the suggested configuration.  It has been tested--with excellent
  43. results--under WorkBench 2.0.  However, certain bugs (unbeknownst to us)
  44. may arise, and therefore, we make no claims of 2.0 compatibility.  Using
  45. the program on any other system that does not conform to the intended
  46. specifications may yield strange and bizzare results (can you say guru?).
  47.  
  48. Mod2Exe has been tested on a 33 Mhz 68030, with good results. So it is
  49. relatively safe to assume that Mod2Exe will work on higher processors.  We
  50. thank Robbie for testing Mod2Exe on his machine! =-)
  51.  
  52.                         .------------------------.
  53.                         |** How it works (1.3) **|
  54.                         `------------------------'
  55.  
  56. Mod2Exe is a very simple program to use.
  57.  
  58. Under WorkBench version 1.3, you may only use it from the CLI.  By simply
  59. typing the name, you will be presented with the following text:
  60.  
  61. Mod2Exe 1.05
  62. Written by Allan Saddi.
  63. Copyright © 1991 By Philosophy SoftWorks.
  64. All Rights Reserved.
  65.  
  66. Usage: Mod2Exe <mod file> <executable file> [PAL] [ICON]
  67.  
  68. This line (beginning with Usage) is the "Syntax" line.  It shows you in
  69. what order the program expects the information (parameters).  Following is
  70. a brief explanation of the parameters.
  71.  
  72. The "mod file" field is the path/name of the source mod file.  "Executable
  73. file" is the destination path/name for the executable.  Use the "PAL"
  74. switch if you wish that the mod is played in PAL speed.  Use the "ICON"
  75. switch if you want the program to automatically write an icon out for the
  76. created executable.
  77.  
  78. Version 1.05 Note: The mod should play at the right speeds now, even on PAL
  79. machines. This is accountable to the fact that the play routines, normally
  80. timed on the vertical blank frequency, is now timed on one of CIAB's timers.
  81. Also, the executable mod will attempt to allocate the audio channels now --
  82. to keep other programs from using the audio simultaneously and possibly
  83. crashing the machine. Also note that Mod2Exe and KillPlayer are both
  84. re-entrant and pure. Unfortunately, executable mods are not. I may fix this
  85. in a later version. - Allan
  86.  
  87.                         .------------------------.
  88.                         |** How it works (2.0) **|
  89.                         `------------------------'
  90.  
  91. Basically everything is the same here.  To use the program, select "All
  92. files" in the "window/show" menus in the current directory's window.  Click
  93. on Mod2Exe's icon or name (depending on how you have 2.0 configured).  Now,
  94. a window entitled "Execute a file" should pop up.  In the window should be
  95. a string gadget and the words "Enter command arguments:".  In the string
  96. gadget should be the word "Mod2Exe" already.  Now type the parameters in
  97. the requester just like you would type them from the CLI.
  98.  
  99. 2.0 will now open a window entitled "Command output window" (or something
  100. to that effect).  Mod2Exe will work for a little while, and as soon as you
  101. think its done, close the output window.
  102.  
  103.                        .--------------------------.
  104.                        |** ...and like magic... **|
  105.                        `--------------------------'
  106.  
  107. And presto chango!  You should now have a completely executable mod.  We
  108. suggest that (as you should before doing ANYTHING new) you save everything
  109. that might get lost if you crashed as you try and run your new executable.
  110. This is not insecurity on our parts, just preventive thinking.  This step
  111. is ESPECIALLY important on machines that have configurations other than the
  112. suggested setup.
  113.  
  114. Double click on the mod's icon or type its name from the CLI and be
  115. prepared to be thrilled with your great sounding mod (remember, MS-DOS'ers
  116. pay a high premium for half of the Amiga's sound ability, so think of a
  117. beamer:  don't take your mods for granted). :-)
  118.  
  119.                          .-----------------------.
  120.                          |** Stopping Mod Play **|
  121.                          `-----------------------'
  122.  
  123. To stop a mod from playing, simply double click (or type from the CLI) the
  124. "KillPlayer" icon.  This will abort whatever song is in progress.
  125. Additionally, if you double click (or type from the CLI) the name of any
  126. executable mod (including the current one) the player stops.
  127.  
  128.                           .--------------------.
  129.                           |** Error messages **|
  130.                           `--------------------'
  131.  
  132. The process is so simple you really shouldn't run into any errors except
  133. due to typos.  Occasionally with rather large mods, you may run into a
  134. situation where you run out of memory.  In this case, you don't have very
  135. many options unless you take it over to a friend's house who has more
  136. memory or something.  In any case, a self-explaintory error message will be
  137. displayed upon a failure.
  138.  
  139.                             .-----------------.
  140.                             |** Legal Stuff **|
  141.                             `-----------------'
  142.  
  143. You may freely copy this program as long as all the files included within
  144. this archive are distributed along with the executable.  Also, you may
  145. not alter any of them in any way.  If you have an idea or suggestion for the
  146. author, discuss it with him, DO NOT make your own changes and then
  147. distribute the altered version.  We do not assume any liability for any
  148. damages caused through the use of this program.  It has been tested for bugs,
  149. however we make no guarentees that it will work exactly as described.  You
  150. are accepting this software "AS IS". There is NO guarentee made that it will
  151. perform to your expectations.  By using this software you are acknowledging
  152. the fact that you have read this documentation and agree with the terms of
  153. licensing stated above.
  154.  
  155. Mod2Exe is being released under the term "freely distributable".  You MAY
  156. copy it, include it in collections, upload it to BBSs, anything you see
  157. fit, as long as the following 3 conditions are met.  1) You do not make ANY
  158. money whatsoever off of it.  This is not to be confused with money from
  159. duplicating costs or modest media expenses.  2) The entire archive remains
  160. INTACT and UNCHANGED!!  This is extremely important!!  I don't believe that
  161. it is necessary to go into the particulars of this.  3) You are giving it
  162. to someone who will--to the best of your knowledge--respect these
  163. conditions as well.  Thank you.
  164.  
  165.           -------------------------------------------------------
  166.  
  167.                               Mod2Exe Credits
  168.  
  169.                          Programmed by Allan Saddi
  170.                        Docs & Icons by Kelly Hallman
  171.                       Idea & Testing by Richard Jones
  172.                      Additional Testing by Jeff Castle
  173.                            and Robbie Van Buren
  174.  
  175.           -------------------------------------------------------
  176.  
  177.              Send all comments, suggestions, pats on back to:
  178.  
  179.                                 Snail Mail:
  180.  
  181.                                 Allan Saddi
  182.                              929 West Creston
  183.                            Santa Maria, CA 93454
  184.  
  185.                               Internet Mail:
  186.  
  187.                        asaddi@caticsuf.CSUFresno.EDU
  188.  
  189.           -------------------------------------------------------
  190.  
  191.                     Send all bug reports to NIL: !! :-)
  192.  
  193.           -------------------------------------------------------
  194.  
  195.                   Mod2Exe © 1991 by Philosophy SoftWorks
  196.                     Version 1.00 Release Date: 12/01/91
  197.                     Version 1.05 Release Date: 01/04/92
  198.  
  199.           -------------------------------------------------------
  200.  
  201.  
  202.